SetScreenTipText

Sets the screen tip text of the hyperlink.

Syntax

expression.SetScreenTipText(sScreenTipText);

expression - A variable that represents a ApiHyperlink class.

Parameters

Name	Required/Optional	Data type	Default	Description
sScreenTipText	Required	string		The screen tip text of the hyperlink.

Returns

boolean

Example

This example sets the screen tip text of the hyperlink.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let run = Api.CreateRun();
run.AddText("ONLYOFFICE Document Builder");
paragraph.AddElement(run);
let hyperlink = paragraph.AddHyperlink("https://api.onlyoffice.com/docbuilder/basic");
hyperlink.SetScreenTipText("ONLYOFFICE for developers");
let screenTipText = hyperlink.GetScreenTipText();
paragraph = Api.CreateParagraph();
paragraph.AddText("Screen tip text: " + screenTipText);
doc.Push(paragraph);